/*
 * Copyright (c) 2018, 2024, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * The Universal Permissive License (UPL), Version 1.0
 *
 * Subject to the condition set forth below, permission is hereby granted to any
 * person obtaining a copy of this software, associated documentation and/or
 * data (collectively the "Software"), free of charge and under any and all
 * copyright rights in the Software, and any and all patent rights owned or
 * freely licensable by each licensor hereunder covering either (i) the
 * unmodified Software as contributed to or provided by such licensor, or (ii)
 * the Larger Works (as defined below), to deal in both
 *
 * (a) the Software, and
 *
 * (b) any piece of software and/or hardware listed in the lrgrwrks.txt file if
 * one is included with the Software each a "Larger Work" to which the Software
 * is contributed by such licensors),
 *
 * without restriction, including without limitation the rights to copy, create
 * derivative works of, display, perform, and distribute the Software and make,
 * use, sell, offer for sale, import, export, have made, and have sold the
 * Software and the Larger Work(s), and to sublicense the foregoing rights on
 * either these or other terms.
 *
 * This license is subject to the following condition:
 *
 * The above copyright notice and either this complete permission notice or at a
 * minimum a reference to the UPL must be included in all copies or substantial
 * portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
package com.oracle.graal.python.builtins.objects.dict;

import com.oracle.graal.python.builtins.objects.common.ForeignHashingStorage;
import com.oracle.graal.python.builtins.objects.common.HashingStorage;
import com.oracle.graal.python.builtins.objects.common.HashingStorageNodes;
import com.oracle.graal.python.builtins.objects.common.PHashingCollection;
import com.oracle.graal.python.builtins.objects.object.PythonBuiltinObject;
import com.oracle.truffle.api.object.Shape;

public abstract class PDictView extends PythonBuiltinObject {
    private final Object dict;
    private final ForeignHashingStorage foreignHashingStorage;
    private final String name;

    public PDictView(Object clazz, Shape instanceShape, String name, PHashingCollection dict) {
        this(clazz, instanceShape, name, dict, null);
    }

    public PDictView(Object clazz, Shape instanceShape, String name, Object dict, ForeignHashingStorage foreignHashingStorage) {
        super(clazz, instanceShape);
        this.name = name;
        assert dict != null;
        this.dict = dict;
        assert foreignHashingStorage == null || foreignHashingStorage.foreignDict == dict;
        this.foreignHashingStorage = foreignHashingStorage;
    }

    public final Object getWrappedDict() {
        return dict;
    }

    public final HashingStorage getWrappedStorage() {
        if (foreignHashingStorage != null) {
            return foreignHashingStorage;
        } else {
            return ((PHashingCollection) dict).getDictStorage();
        }
    }

    public String getName() {
        return name;
    }

    public abstract static class PBaseDictIterator extends PHashingStorageIterator {

        public PBaseDictIterator(Object clazz, Shape instanceShape, HashingStorageNodes.HashingStorageIterator iterator, HashingStorage hashingStorage, int initialSize) {
            super(clazz, instanceShape, hashingStorage, iterator, initialSize);
        }
    }

    // -----------------------------------------------------------------------------------------------------------------
    //
    // the keys
    //
    // -----------------------------------------------------------------------------------------------------------------
    public static final class PDictKeyIterator extends PBaseDictIterator {
        public PDictKeyIterator(Object clazz, Shape instanceShape, HashingStorageNodes.HashingStorageIterator iterator, HashingStorage hashingStorage, int initialSize) {
            super(clazz, instanceShape, iterator, hashingStorage, initialSize);
        }
    }

    public static final class PDictKeysView extends PDictView {

        public PDictKeysView(Object clazz, Shape instanceShape, PHashingCollection dict) {
            super(clazz, instanceShape, "dict_keys", dict);
        }

        public PDictKeysView(Object clazz, Shape instanceShape, Object dict, ForeignHashingStorage foreignHashingStorage) {
            super(clazz, instanceShape, "dict_keys", dict, foreignHashingStorage);
        }
    }

    // -----------------------------------------------------------------------------------------------------------------
    //
    // the values
    //
    // -----------------------------------------------------------------------------------------------------------------
    public static final class PDictValueIterator extends PBaseDictIterator {
        public PDictValueIterator(Object clazz, Shape instanceShape, HashingStorageNodes.HashingStorageIterator iterator, HashingStorage hashingStorage, int initialSize) {
            super(clazz, instanceShape, iterator, hashingStorage, initialSize);
        }
    }

    public static final class PDictValuesView extends PDictView {

        public PDictValuesView(Object clazz, Shape instanceShape, PHashingCollection dict) {
            super(clazz, instanceShape, "dict_values", dict);
        }

        public PDictValuesView(Object clazz, Shape instanceShape, Object dict, ForeignHashingStorage foreignHashingStorage) {
            super(clazz, instanceShape, "dict_values", dict, foreignHashingStorage);
        }
    }

    // -----------------------------------------------------------------------------------------------------------------
    //
    // the items
    //
    // -----------------------------------------------------------------------------------------------------------------
    public static final class PDictItemIterator extends PBaseDictIterator {
        public PDictItemIterator(Object clazz, Shape instanceShape, HashingStorageNodes.HashingStorageIterator iterator, HashingStorage hashingStorage, int initialSize) {
            super(clazz, instanceShape, iterator, hashingStorage, initialSize);
        }
    }

    public static final class PDictItemsView extends PDictView {

        public PDictItemsView(Object clazz, Shape instanceShape, PHashingCollection dict) {
            super(clazz, instanceShape, "dict_items", dict);
        }

        public PDictItemsView(Object clazz, Shape instanceShape, Object dict, ForeignHashingStorage foreignHashingStorage) {
            super(clazz, instanceShape, "dict_items", dict, foreignHashingStorage);
        }
    }
}
